Feat/generate sn6 schema validation #394

arnoox · 2026-02-06T11:29:46Z

📌 Description

Add sn_schemas.py which translates metamodel.yaml into a schemas.json file consumable by sphinx-needs 6. This enables schema-based validation at parse time: required fields, regex patterns on option values, mandatory link presence (minItems: 1), and mandatory link target type checks (validate.network).
Because ubCode (the VS Code extension for sphinx-needs) evaluates these schemas during editing, all metamodel violations now surface as IDE diagnostics directly in the editor -- errors are caught early with lightweight, fast rendering, without waiting for a full Sphinx build.
Add comprehensive unit tests (test_sn_schemas.py) and integration tests (test_sn_schemas_integration.py) that validate generated schemas against the real S-CORE metamodel using jsonschema_rs, the same engine sphinx-needs uses at runtime.
Fix regex patterns in metamodel.yaml (\d -> [0-9]) for JSON Schema compatibility. TODO: really?
Add developer documentation (README.md) covering the two validation layers (schema vs. post-build Python checks) with a detailed coverage comparison table.

🚨 Impact Analysis

This change does not violate any tool requirements and is covered by existing tool requirements
This change does not violate any design decisions
Otherwise I have created a ticket for new tool qualification

✅ Checklist

Added/updated documentation for new or changed features
Added/updated tests to cover the changes
Followed project coding standards and guidelines

…hemas.json

… docs succeeds

github-actions · 2026-02-06T11:30:20Z

License Check Results

🚀 The license check job ran with the Bazel command:

bazel run //src:license-check

Status: ⚠️ Needs Review

Click to expand output

[License Check Output]
Extracting Bazel installation...
Starting local Bazel server (8.3.0) and connecting to it...
INFO: Invocation ID: 9833172e-5685-47be-94b5-58d477fe0876
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Computing main repo mapping: 
Loading: 
Loading: 0 packages loaded
Loading: 0 packages loaded
Loading: 0 packages loaded
    currently loading: src
Loading: 0 packages loaded
    currently loading: src
Analyzing: target //src:license-check (1 packages loaded, 0 targets configured)
Analyzing: target //src:license-check (1 packages loaded, 0 targets configured)

Analyzing: target //src:license-check (57 packages loaded, 9 targets configured)

Analyzing: target //src:license-check (69 packages loaded, 9 targets configured)

Analyzing: target //src:license-check (76 packages loaded, 9 targets configured)

Analyzing: target //src:license-check (126 packages loaded, 859 targets configured)

Analyzing: target //src:license-check (129 packages loaded, 2225 targets configured)

Analyzing: target //src:license-check (140 packages loaded, 2574 targets configured)

Analyzing: target //src:license-check (140 packages loaded, 2576 targets configured)

Analyzing: target //src:license-check (140 packages loaded, 2576 targets configured)

INFO: Analyzed target //src:license-check (145 packages loaded, 4715 targets configured).
[1 / 1] no actions running
[13 / 16] JavaToolchainCompileClasses external/rules_java+/toolchains/platformclasspath_classes; 0s disk-cache, processwrapper-sandbox
[15 / 16] Building src/license.check.license_check.jar (); 0s disk-cache, multiplex-worker
INFO: Found 1 target...
Target //src:license.check.license_check up-to-date:
  bazel-bin/src/license.check.license_check
  bazel-bin/src/license.check.license_check.jar
INFO: Elapsed time: 24.169s, Critical Path: 2.51s
INFO: 16 processes: 12 internal, 3 processwrapper-sandbox, 1 worker.
INFO: Build completed successfully, 16 total actions
INFO: Running command line: bazel-bin/src/license.check.license_check src/formatted.txt <args omitted>
usage: org.eclipse.dash.licenses.cli.Main [-batch <int>] [-cd <url>]
       [-confidence <int>] [-ef <url>] [-excludeSources <sources>] [-help] [-lic
       <url>] [-project <shortname>] [-repo <url>] [-review] [-summary <file>]
       [-timeout <seconds>] [-token <token>]

github-actions · 2026-02-06T11:34:54Z

The created documentation from the pull request is available at: docu-html

…nto feat/generate-sn6-schema-validation

ubmarco

I'm missing a test for this. Ideally the generated schema.json is tested against the same SCORE metamodel tests. Then we can be sure the migration was successful.

ubmarco · 2026-02-06T13:01:49Z

src/extensions/score_metamodel/metamodel.yaml

      # req-Id: tool_req__docs_common_attr_status
      status: ^(valid|draft)$
-      content: ^[\s\S]+$
+      content: ^(.|[\n\r])+$


Please check whether these regexes make any trouble in SN6.
Maybe they work in jsonschema-rs. I changed those before we did the migration from jsonschema to jsonschema-rs.

I re-introduced the original regex string, which runs as expected.

ubmarco · 2026-02-06T13:02:31Z

src/extensions/score_metamodel/sn_schemas.py

+Schema structure per need type (sphinx-needs schema format):
+  - ``select``  : matches needs by their ``type`` field
+  - ``validate.local``   : validates the need's own properties (patterns, required)
+  - ``validate.network`` : validates properties of linked needs (NOT YET ACTIVE)


Why is network not yet active? Is that a thing for another PR?

I Just feared this is too big. Looking into it right now. Change size seems to be acceptable, so I'll include it in this PR.

…n by refining regex patterns and adding type hints

…odel

arnoox · 2026-02-09T09:24:23Z

Thanks for the review!

I'm missing a test for this. Ideally the generated schema.json is tested against the same SCORE metamodel tests. Then we can be sure the migration was successful.

Yeah this was still work in progress. I introduced a refactored/more testable version of the sn_schemas transformation, including unit/integration tests.

…ion process

…ndatory links and updating tests

…ertions for clarity

… logic

…n schema validation

…de diagnostics

arnoox · 2026-02-11T08:44:33Z

src/extensions/score_metamodel/metamodel.yaml

      # req-Id: tool_req__docs_req_attr_validity_correctness
-      valid_from: ^v(0|[1-9]\d*)\.(0|[1-9]\d*)(\.(0|[1-9]\d*))?$
-      valid_until: ^v(0|[1-9]\d*)\.(0|[1-9]\d*)(\.(0|[1-9]\d*))?$
+      valid_from: ^v(0|[1-9][0-9]*)\.(?:0|[1-9][0-9]*)(\.(0|[1-9][0-9]*))?$


Check if the original regex are still working. If yes: revert.

…com/arnoox/score-docs-as-code into feat/generate-sn6-schema-validation

arnoox · 2026-02-11T10:01:00Z

The schema validation caught a new error in the score repo. We first need to fix it: eclipse-score/score#2581

arnoox added 2 commits February 6, 2026 11:20

feat: implement schema validation for Sphinx-Needs using generated sc…

c0a88fd

…hemas.json

fix: update ID regex pattern to include uppercase letters - bazel run…

84351db

… docs succeeds

github-project-automation bot added this to INF - Infrastructure Community Feb 6, 2026

github-project-automation bot moved this to Draft in INF - Infrastructure Community Feb 6, 2026

arnoox added 2 commits February 6, 2026 12:35

Merge branch 'main' of https://github.com/arnoox/score-docs-as-code i…

619fa50

…nto feat/generate-sn6-schema-validation

refactor: clean up print statements in schema generation process

dc99d47

ubmarco suggested changes Feb 6, 2026

View reviewed changes

arnoox added 3 commits February 9, 2026 07:47

feat: refactored sn_schema for testabiblity; enhance schema validatio…

ae8ce7e

…n by refining regex patterns and adding type hints

Added unit tests for sn_schemas

2a5cfd5

feat: add integration tests for schema generation against SCORE metam…

a805e48

…odel

arnoox added 8 commits February 9, 2026 09:29

refactor: remove unused imports and clean up whitespace in test files

4e09175

feat: update documentation and comments for clarity on schema generat…

2b2f0f6

…ion process

feat: enhance schema validation by refining network validation for ma…

e2ad71b

…ndatory links and updating tests

refactor: simplify optional links classification and improve test ass…

8d90169

…ertions for clarity

refactor: improve comment formatting for clarity in schema validation…

6b3a832

… logic

feat: add logging for existing links and warnings for missing needs i…

2be684f

…n schema validation

feat: enhance README to clarify metamodel validation in IDE with ubCo…

02e25a2

…de diagnostics

Merge branch 'main' into feat/generate-sn6-schema-validation

1a065be

arnoox commented Feb 11, 2026

View reviewed changes

arnoox added 2 commits February 11, 2026 09:07

feat: refine regex patterns for version validation in needs_types

1d9119a

Merge branch 'feat/generate-sn6-schema-validation' of https://github.…

3c098db

…com/arnoox/score-docs-as-code into feat/generate-sn6-schema-validation

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat/generate sn6 schema validation #394

Feat/generate sn6 schema validation #394

Uh oh!

arnoox commented Feb 6, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Feb 6, 2026 •

edited

Loading

Uh oh!

github-actions bot commented Feb 6, 2026

Uh oh!

ubmarco left a comment

Uh oh!

ubmarco Feb 6, 2026

Uh oh!

arnoox Feb 9, 2026

Uh oh!

ubmarco Feb 6, 2026

Uh oh!

arnoox Feb 9, 2026

Uh oh!

arnoox Feb 9, 2026

Uh oh!

arnoox commented Feb 9, 2026

Uh oh!

arnoox Feb 11, 2026

Uh oh!

arnoox commented Feb 11, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Feat/generate sn6 schema validation #394

Are you sure you want to change the base?

Feat/generate sn6 schema validation #394

Uh oh!

Conversation

arnoox commented Feb 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

📌 Description

🚨 Impact Analysis

✅ Checklist

Uh oh!

github-actions bot commented Feb 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

License Check Results

Uh oh!

github-actions bot commented Feb 6, 2026

Uh oh!

ubmarco left a comment

Choose a reason for hiding this comment

Uh oh!

ubmarco Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

arnoox Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

ubmarco Feb 6, 2026

Choose a reason for hiding this comment

Uh oh!

arnoox Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

arnoox Feb 9, 2026

Choose a reason for hiding this comment

Uh oh!

arnoox commented Feb 9, 2026

Uh oh!

arnoox Feb 11, 2026

Choose a reason for hiding this comment

Uh oh!

arnoox commented Feb 11, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

arnoox commented Feb 6, 2026 •

edited

Loading

github-actions bot commented Feb 6, 2026 •

edited

Loading